//
// Text.h
//
// Library: XML
// Package: DOM
// Module:  DOM
//
// Definition of the DOM Text class.
//
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// SPDX-License-Identifier:	BSL-1.0
//


#ifndef DOM_Text_INCLUDED
#define DOM_Text_INCLUDED


#include "Poco/DOM/CharacterData.h"
#include "Poco/XML/XML.h"
#include "Poco/XML/XMLString.h"


namespace Poco
{
namespace XML
{


    class XML_API Text : public CharacterData
    /// The Text interface inherits from CharacterData and represents the textual
    /// content (termed character data in XML) of an Element or Attr. If there is
    /// no markup inside an element's content, the text is contained in a single
    /// object implementing the Text interface that is the only child of the element.
    /// If there is markup, it is parsed into the information items (elements, comments,
    /// etc.) and Text nodes that form the list of children of the element.
    ///
    /// When a document is first made available via the DOM, there is only one Text
    /// node for each block of text. Users may create adjacent Text nodes that represent
    /// the contents of a given element without any intervening markup, but should
    /// be aware that there is no way to represent the separations between these
    /// nodes in XML or HTML, so they will not (in general) persist between DOM
    /// editing sessions. The normalize() method on Element merges any such adjacent
    /// Text objects into a single node for each block of text.
    {
    public:
        Text * splitText(unsigned long offset);
        /// Breaks this node into two nodes at the specified offset, keeping both in
        /// the tree as siblings. This node then only contains all the content up to
        /// the offset point. A new node of the same type, which is inserted as the
        /// next sibling of this node, contains all the content at and after the offset
        /// point. When the offset is equal to the length of this node, the new node
        /// has no data.

        // Node
        const XMLString & nodeName() const;
        unsigned short nodeType() const;

        // Non-standard extensions
        XMLString innerText() const;

    protected:
        Text(Document * pOwnerDocument, const XMLString & data);
        Text(Document * pOwnerDocument, const Text & text);
        ~Text();

        Node * copyNode(bool deep, Document * pOwnerDocument) const;

    private:
        static const XMLString NODE_NAME;

        friend class Document;
    };


}
} // namespace Poco::XML


#endif // DOM_Text_INCLUDED
